NPC Functions and Variables Documentation

Functions and Properties

Return Type	Function Information
`bool`	`isValid()Returns whether or not this NPC pointer is still valid. A pointer becomes invalid if the enemy dies or Link leaves the screen. Trying to access any variable of an invalid NPC pointer prints an error to allegro.log and does nothing.`
`void`	`GetName(int buffer[])Loads the npc's name into 'buffer'. To load an NPC from an ID rather than a pointer use 'GetNPCName' from std.zh`
`int`	`IDThe NPC's enemy ID number. npc->ID is read-only; while setting it is not syntactically incorrect, it does nothing.`
`int`	`TypeThe NPC's Type. Use the NPCT_ constants in std.zh to compare this value. npc->Type is read-only; while setting it is not syntactically incorrect, it does nothing.`
`int`	`XThe NPC's current X coordinate, in pixels. Float values passed to this will be cast to int.`
`int`	`YThe NPC's current Y coordinate, in pixels. Float values passed to this will be cast to int.`
`int`	`ZThe NPC's current Z coordinate, in pixels. Float values passed to this will be cast to int.`
`int`	`JumpThe NPC's upward velocity, in pixels. If negative, the NPC will fall. The downward acceleration of Gravity (in Init Data) modifies this value every frame.`
`int`	`DirThe direction the NPC is facing. Use the DIR_ constants in std.zh to set and compare this value.`
`int`	`RateThe rate at which the NPC changes direction. For a point of reference the "Octorok (Magic)" enemy has a rate of 16. The effect of writing to this field is currently undefined.`
`int`	`HaltrateThe extent to which the NPC stands still while moving around the screen. As a point of reference, the Zols and Gels have haltrate of 16. The effect of writing to this field is currently undefined.`
`int`	`HomingHow likely the NPC is to move towards Link. The effect of writing to this field is currently undefined.`
`int`	`HungerHow likely the NPC is to move towards bait. The effect of writing to this field is currently undefined.`
`int`	`StepThe NPC's movement speed. A Step of 100 usually means that the enemy moves at approximately one pixel per animation frame. As a point of reference, the "Octorok (Magic)" enemy has a step of 200. The effect of writing to this field is currently undefined.`
`bool`	`CollDetectionWhether the NPC will use the system's code to work out collisions with Link Initialised as 'true'.`
`int`	`ASpeedThe the NPC's animation frame rate, in screen frames. The effect of writing to this field is currently undefined.`
`int`	`DrawStyleThe way the NPC is animated. Use the DS_ constants in std.zh to set or compare this value. The effect of writing to this field is currently undefined.`
`int`	`HPThe NPC's current hitpoints. A weapon with a Power of 1 removes 2 hitpoints.`
`int`	`DamageThe amount of damage dealt to an unprotected Link when he touches this NPC, in quarter-hearts.`
`int`	`WeaponDamageThe amount of damage dealt to an unprotected Link by this NPC's weapon, in quarter-hearts.`
`int`	`StunThe time, in frames, that the NPC will be stunned. Some types of enemies cannot be stunned.`
`int`	`OriginalTileThe number of the starting tile used by this NPC.`
`int`	`TileThe current tile associated with this NPC. The effect of writing to this variable is undefined.`
`int`	`WeaponThe weapon used by this enemy. Use the WPN_ constants (NOT the EW_ constants) in std.zh to set or compare this value.`
`int`	`ItemSetThe items that the NPC might drop when killed. Use the IS_ constants in std.zh to set or compare this value.`
`int`	`CSetThe CSet used by this NPC.`
`int`	`BossPalThe boss pallete used by this NPC; this pallete is only used if CSet is 14 (the reserved boss cset). Use the BPAL_ constants in std.zh to set or compare this value.`
`int`	`SFXThe sound effects emitted by the enemy. Use the SFX_ constants in std.zh to set or compare this value.`
`int`	`ExtendWhether to extend the sprite of the enemy.`
`int`	`TileWidthThe number of tile columns composing the sprite. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`TileHeightThe number of tile rows composing the sprite. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`HitWidthThe width of the sprite's hitbox, or collision rectangle.`
`int`	`HitHeightThe height of the sprite's hitbox, or collision rectangle.`
`int`	`HitZHeightThe Z-axis height of the sprite's hitbox, or collision rectangle. The greater it is, the higher Link must jump or fly over the sprite to avoid taking damage.`
`int`	`HitXOffsetThe X offset of the sprite's hitbox, or collision rectangle. Setting it to positive or negative values will move the sprite's hitbox left or right.`
`int`	`HitYOffsetThe Y offset of the sprite's hitbox, or collision rectangle. Setting it to positive or negative values will move the sprite's hitbox up or down.`
`int`	`DrawXOffsetThe X offset of the sprite. Setting it to positive or negative values will move the sprite's tiles left or right relative to its position.`
`int`	`DrawYOffsetThe Y offset of the sprite. In non-sideview screens, this is usually -2. Setting it to positive or negative values will move the sprite's tiles up or down relative to its position.`
`int`	`DrawZOffsetThe Z offset of the sprite. This is ignored unless Extend is set to values >=3.`
`int`	`Defense[]The npc's Defense values, as an array of 18 integers. Use the NPCD_ and NPCDT_ constants in std.zh to set or compare these values.`
`int`	`Attributes[]The npc's Miscellaneous Attributes, as an array of ten integers. They are read-only; while setting them is not syntactically incorrect, it does nothing.`
`int`	`MiscFlagsThe npc's Misc. Flags as 14 bits ORed together, starting with 'Damaged by Power 0 Weapons' and working down the flags in the order they are shown in the Enemy Editor. npc->MiscFlags is read-only; while setting it is not syntactically incorrect, it does nothing. If you are not comfortable with binary operations, you can use 'GetNPCMiscFlag' from std.zh`
`float`	`Misc[]An array of 16 miscellaneous variables for you to use as you please.`
`void`	`BreakShield()Breaks the enemy's shield if it has one. This works even if the flag`